2.5 [Includes] Usage
This is an optional section.
The [Includes]
section is used to identify the "standard" location "include
directories" provide by this EDK II package. The [Includes]
contains a list
of package relative directory names. These directories contain sub-directories
or header files. If the Package directory contains the directories, and the
Include
, Include/Ppis
, Include/Protocol
and Include/Guid
, and header
files exist in each of these directories, then all four directories will be
listed in this section.
This list of directories is used by the build tools to create the list of standard directory locations required by compilers.
Also included in this section are the directories containing headers that may be required for individual EDK II module types. Refer to Appendix, "EDK II Module Types", for a list of the valid types.
The section tag modifier, Private
, is used to restrict the EDK II build
system by preventing references to content in these sections from being used by
modules outside of the package.
Refer to the [Includes]
definition later in this document for a complete
description of this section and its contents.
The [Includes]
section uses one of the following section definitions:
[Includes]
[Includes.common]
[Includes.common.Private]
[Includes.IA32]
[Includes.IA32.Private]
[Includes.X64]
[Includes.X64.Private]
[Includes.IPF]
[Includes.IPF.Private]
[includes.EBC]
[includes.EBC.Private]
Architectural sections may also be combined, as in:
[Includes.IA32, Includes.X64]
[Includes.IA32.Private, Includes.X64.Private]
The format for entries in this section is one field, with an optional comment
"#
" field as shown below:
Package_Relative/path # Comment such as Keyword List
The relative path is relative to the directory the DEC file is in. Use of "..", "./" and "../" in the directory path is not permitted.
Caution: Do not list individual files in the [Includes]
section.